/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

\*---------------------------------------------------------------------------*/

#include "definedInjector.H"
#include "addToRunTimeSelectionTable.H"
#include "mathematicalConstants.H"

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
    defineTypeNameAndDebug(definedInjector, 0);

    addToRunTimeSelectionTable
    (
        injectorType,
        definedInjector,
        dictionary
    );
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::definedInjector::definedInjector
(
    const Time& t,
    const dictionary& dict
)
:
    injectorType(t, dict),
    propsDict_(dict.subDict(typeName + "Props")),
    position_(propsDict_.lookup("position")),
    direction_(propsDict_.lookup("direction")),
    d_(readScalar(propsDict_.lookup("diameter"))),
    mass_(readScalar(propsDict_.lookup("mass"))),
    T_(readScalar(propsDict_.lookup("temperature"))),
    nParcels_(readLabel(propsDict_.lookup("nParcels"))),
    X_(propsDict_.lookup("X")),
    massFlowRateProfile_(propsDict_.lookup("massFlowRateProfile")),
    velocityProfile_(propsDict_.lookup("velocityProfile")),
    injectionPressureProfile_(massFlowRateProfile_),
    CdProfile_(massFlowRateProfile_),
    averageParcelMass_(mass_/nParcels_),
    pressureIndependentVelocity_(true)
{
    // convert CA to real time - mass flow rate profile
    forAll(massFlowRateProfile_, i)
    {
        massFlowRateProfile_[i][0] =
            t.userTimeToTime(massFlowRateProfile_[i][0]);
        // dummy
        injectionPressureProfile_[i][0] = massFlowRateProfile_[i][0];
        injectionPressureProfile_[i][1] = 0.0;
        CdProfile_[i][0] = massFlowRateProfile_[i][0];
        CdProfile_[i][1] = 1.0;
    }

    forAll(velocityProfile_, i)
    {
        velocityProfile_[i][0] = t.userTimeToTime(velocityProfile_[i][0]);
    }

    // check if time entries match
    if (mag(massFlowRateProfile_[0][0]-velocityProfile_[0][0]) > SMALL)
    {
        FatalErrorIn
        (
            "definedInjector::definedInjector"
            "(const time& t, const dictionary dict)"
        )   << "Start-times do not match for velocityProfile and "
            << "massFlowRateProfile." << nl
            << abort(FatalError);
    }

    if
    (
        mag(massFlowRateProfile_.last()[0] - velocityProfile_.last()[0])
      > SMALL
    )
    {
        FatalErrorIn
        (
            "definedInjector::definedInjector"
            "(const time& t, const dictionary dict)"
        )   << "End-times do not match for velocityProfile and "
            << "massFlowRateProfile."
            << abort(FatalError);
    }

    // calculate integral of mass flow rate profile
    scalar integratedMFR = integrateTable(massFlowRateProfile_);

    // correct the massFlowRate profile to match the injector
    forAll(massFlowRateProfile_, i)
    {
        massFlowRateProfile_[i][1] *= mass_/integratedMFR;
    }

    // Normalize the direction vector
    direction_ /= mag(direction_);

    setTangentialVectors();

    // check molar fractions
    scalar Xsum = 0.0;
    forAll(X_, i)
    {
        Xsum += X_[i];
    }

    if (mag(Xsum - 1.0) > SMALL)
    {
        WarningIn
        (
            "definedInjector::definedInjector"
            "(const time& t, const dictionary dict)"
        )   << "X does not add up to 1.0, correcting molar fractions."
            << endl;

        forAll(X_, i)
        {
            X_[i] /= Xsum;
        }
    }
}


// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

Foam::definedInjector::~definedInjector()
{}


// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

void Foam::definedInjector::setTangentialVectors()
{
    cachedRandom rndGen(label(0), -1);
    scalar magV = 0.0;
    vector tangent;

    while (magV < SMALL)
    {
        vector testThis = rndGen.sample01<vector>();

        tangent = testThis - (testThis & direction_)*direction_;
        magV = mag(tangent);
    }

    tangentialInjectionVector1_ = tangent/magV;
    tangentialInjectionVector2_ = direction_ ^ tangentialInjectionVector1_;
}


Foam::label Foam::definedInjector::nParcelsToInject
(
    const scalar time0,
    const scalar time1
) const
{

    scalar mInj = mass_*(fractionOfInjection(time1)-fractionOfInjection(time0));
    label nParcels = label(mInj/averageParcelMass_ + 0.49);

    return nParcels;
}


const Foam::vector Foam::definedInjector::position(const label n) const
{
    return position_;
}


Foam::vector Foam::definedInjector::position
(
    const label n,
    const scalar time,
    const bool twoD,
    const scalar angleOfWedge,
    const vector& axisOfSymmetry,
    const vector& axisOfWedge,
    const vector& axisOfWedgeNormal,
    cachedRandom& rndGen
) const
{
    if (twoD)
    {
        scalar is = position_ & axisOfSymmetry;
        scalar magInj = mag(position_ - is*axisOfSymmetry);

        vector halfWedge =
            axisOfWedge*cos(0.5*angleOfWedge)
          + axisOfWedgeNormal*sin(0.5*angleOfWedge);
        halfWedge /= mag(halfWedge);

        return (is*axisOfSymmetry + magInj*halfWedge);
    }
    else
    {
        // otherwise, disc injection
        scalar iRadius = d_*rndGen.sample01<scalar>();
        scalar iAngle = constant::mathematical::twoPi*rndGen.sample01<scalar>();

        return
        (
            position_
          + iRadius
          * (
              tangentialInjectionVector1_*cos(iAngle)
            + tangentialInjectionVector2_*sin(iAngle)
          )
        );

    }

    return position_;
}


Foam::label Foam::definedInjector::nHoles() const
{
    return 1;
}


Foam::scalar Foam::definedInjector::d() const
{
    return d_;
}


const Foam::vector& Foam::definedInjector::direction
(
    const label i,
    const scalar time
) const
{
    return direction_;
}


Foam::scalar Foam::definedInjector::mass
(
    const scalar time0,
    const scalar time1,
    const bool twoD,
    const scalar angleOfWedge
) const
{
    scalar mInj =
        mass_*(fractionOfInjection(time1) - fractionOfInjection(time0));

    // correct mass if calculation is 2D
    if (twoD)
    {
        mInj *= 0.5*angleOfWedge/constant::mathematical::pi;
    }

    return mInj;
}


Foam::scalar Foam::definedInjector::mass() const
{
    return mass_;
}


Foam::scalar Foam::definedInjector::massFlowRate(const scalar time) const
{
    return getTableValue(massFlowRateProfile_, time);
}


Foam::scalar Foam::definedInjector::injectionPressure(const scalar time) const
{
    return getTableValue(injectionPressureProfile_, time);
}


Foam::scalar Foam::definedInjector::Cd(const scalar time) const
{
    return getTableValue(CdProfile_, time);
}


const Foam::scalarField& Foam::definedInjector::X() const
{
    return X_;
}


Foam::List<Foam::definedInjector::pair> Foam::definedInjector::T() const
{
    return TProfile_;
}


Foam::scalar Foam::definedInjector::T(const scalar time) const
{
    return T_;
}


Foam::scalar Foam::definedInjector::tsoi() const
{
    return massFlowRateProfile_.first()[0];
}


Foam::scalar Foam::definedInjector::teoi() const
{
    return massFlowRateProfile_.last()[0];
}


Foam::scalar Foam::definedInjector::fractionOfInjection
(
    const scalar time
) const
{
    return integrateTable(massFlowRateProfile_, time)/mass_;
}


Foam::scalar Foam::definedInjector::velocity
(
    const scalar time
) const
{
    return getTableValue(velocityProfile_, time);
}


Foam::scalar Foam::definedInjector::injectedMass
(
    const scalar t
) const
{
    return mass_*fractionOfInjection(t);
}


void Foam::definedInjector::correctProfiles
(
    const liquidMixtureProperties& fuel,
    const scalar referencePressure
)
{
    scalar A = 0.25*constant::mathematical::pi*sqr(d_);
    scalar pDummy = 1.0e+5;
    scalar rho = fuel.rho(pDummy, T_, X_);

    forAll(velocityProfile_, i)
    {
        scalar mfr = massFlowRateProfile_[i][1];
        scalar v = velocityProfile_[i][1];
        injectionPressureProfile_[i][1] = referencePressure + 0.5*rho*v*v;
        CdProfile_[i][1] = mfr/(v*rho*A);
    }
}


Foam::vector Foam::definedInjector::tan1(const label n) const
{
    return tangentialInjectionVector1_;
}


Foam::vector Foam::definedInjector::tan2(const label n) const
{
    return tangentialInjectionVector2_;
}


// ************************************************************************* //
